Deprecate PaymentSheet Constructors and FlowController.create() #10833

cttsai-stripe · 2025-05-20T06:03:31Z

Summary

Deprecate PaymentSheet constructors
Deprecate PaymentSheet.FlowController.create()
Deprecate rememberPaymentSheet and rememberPaymentSheetFlowController
Document the change in MIGRATING.md

Motivation

We have several new features, e.g. AnalyticCallback, confirmCustomPaymentMethodCallback, that can only be set to a PaymentSheet/FlowController by our new Builder pattern. While the old constructor and factory pattern are still in support for backward compatibility, new features would not be added to this legacy initialization. We are deprecating the old constructors to avoid confusion and point the merchants to our new APIs with migration guide.

Testing

Added tests
Modified tests
Manually verified

Changelog

[DEPRECATED]10833 Deprecated PaymentSheet/FlowController constructors, create methods, and Compose remember functions in favor of new Builder pattern APIs.

github-actions · 2025-05-20T06:09:46Z

Diffuse output:

OLD: identity-example-release-base.apk (signature: V1, V2)
NEW: identity-example-release-pr.apk (signature: V1, V2)

          │          compressed          │         uncompressed         
          ├───────────┬───────────┬──────┼───────────┬───────────┬──────
 APK      │ old       │ new       │ diff │ old       │ new       │ diff 
──────────┼───────────┼───────────┼──────┼───────────┼───────────┼──────
      dex │   2.1 MiB │   2.1 MiB │  0 B │   4.3 MiB │   4.3 MiB │  0 B 
     arsc │     1 MiB │     1 MiB │  0 B │     1 MiB │     1 MiB │  0 B 
 manifest │   2.3 KiB │   2.3 KiB │  0 B │     8 KiB │     8 KiB │  0 B 
      res │ 302.9 KiB │ 302.9 KiB │  0 B │   457 KiB │   457 KiB │  0 B 
   native │   6.2 MiB │   6.2 MiB │  0 B │  15.8 MiB │  15.8 MiB │  0 B 
    asset │   7.7 KiB │   7.7 KiB │  0 B │   7.4 KiB │   7.4 KiB │  0 B 
    other │  95.7 KiB │  95.7 KiB │ +4 B │ 183.5 KiB │ 183.5 KiB │  0 B 
──────────┼───────────┼───────────┼──────┼───────────┼───────────┼──────
    total │   9.8 MiB │   9.8 MiB │ +4 B │  21.8 MiB │  21.8 MiB │  0 B 

 DEX     │ old   │ new   │ diff      
─────────┼───────┼───────┼───────────
   files │     1 │     1 │ 0         
 strings │ 20679 │ 20679 │ 0 (+0 -0) 
   types │  6500 │  6500 │ 0 (+0 -0) 
 classes │  5264 │  5264 │ 0 (+0 -0) 
 methods │ 31505 │ 31505 │ 0 (+0 -0) 
  fields │ 18220 │ 18220 │ 0 (+0 -0) 

 ARSC    │ old  │ new  │ diff 
─────────┼──────┼──────┼──────
 configs │  164 │  164 │  0   
 entries │ 3646 │ 3646 │  0

APK

   compressed    │   uncompressed   │                                           
──────────┬──────┼───────────┬──────┤                                           
 size     │ diff │ size      │ diff │ path                                      
──────────┼──────┼───────────┼──────┼───────────────────────────────────────────
    272 B │ +2 B │     120 B │  0 B │ ∆ META-INF/version-control-info.textproto 
 29.2 KiB │ +2 B │  64.6 KiB │  0 B │ ∆ META-INF/CERT.SF                        
  1.2 KiB │ +1 B │   1.2 KiB │  0 B │ ∆ META-INF/CERT.RSA                       
 25.9 KiB │ -1 B │  64.5 KiB │  0 B │ ∆ META-INF/MANIFEST.MF                    
──────────┼──────┼───────────┼──────┼───────────────────────────────────────────
 56.5 KiB │ +4 B │ 130.5 KiB │  0 B │ (total)

jaynewstrom-stripe · 2025-05-21T20:55:18Z

paymentsheet/src/main/java/com/stripe/android/paymentsheet/PaymentSheetCompose.kt

@@ -22,6 +22,7 @@ import java.util.UUID
 * @param paymentResultCallback Called with the result of the payment after [PaymentSheet] is dismissed.
 */
 @Composable
+@Deprecated(message = "This will be removed in a future release. Use PaymentSheet.Builder instead.")


Can these use the replace with as well?

Yes, we have two options:

add replaceWith expression with remember (key1, ...) { SomeBuilder() } . This would be identical with our deprecated rememberXXX(), but feels like a bit verbose

add replaceWith expression with remember { SomeBuilder() }. This is okay because callbacks basically do not change.

I lean more toward 1. because it avoids breaking implementation accidentally.

paymentsheet/src/main/java/com/stripe/android/paymentsheet/FlowControllerCompose.kt

MIGRATING.md

jaynewstrom-stripe · 2025-06-12T17:33:06Z

CHANGELOG.md

@@ -9,6 +9,7 @@

 ### PaymentSheet
 * [ADDED][10919](https://github.com/stripe/stripe-android/pull/10919) Add `formInsetValues` to `PaymentSheet.Appearance`.
+* [DEPRECATED][10833](https://github.com/stripe/stripe-android/pull/10833) Deprecated PaymentSheet/FlowController constructors, create methods, and Compose remember functions in favor of new Builder pattern APIs.


This is under the wrong release!

MIGRATING.md

Co-authored-by: Jay Newstrom <[email protected]>

jaynewstrom-stripe · 2025-06-12T20:57:13Z

paymentsheet/src/main/java/com/stripe/android/paymentsheet/PaymentSheet.kt

+    @Deprecated(
+        message = "This will be removed in a future release.",
+        replaceWith = ReplaceWith(
+            "Builder(callback)" +


Do these need a prefix? If not, why not?

You mean paymentResultCallback? No, we don't need that because the original constructor is

constructor( activity: ComponentActivity, externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler, callback: PaymentSheetResultCallback, )

I was referring to the Builder call. I thought it would need to be PaymentSheet.Builder or similar.

If using Android Studio to execute the replaceWith action, the IDE will add the import itself.

I'll add the prefix in case the users are using more than one Builder, eg. AlertDialog.Builder, etc.

This was referenced May 20, 2025

Remove unused internalRememberPaymentSheetFlowController #10835

Merged

Remember PaymentSheet/FlowController in playground #10837

Merged

cttsai-stripe force-pushed the cttsai/deprecate-payment-sheet-contructor branch 3 times, most recently from bd65c58 to 7eb9c95 Compare May 21, 2025 19:42

cttsai-stripe requested a review from jaynewstrom-stripe May 21, 2025 20:24

cttsai-stripe marked this pull request as ready for review May 21, 2025 20:24

cttsai-stripe requested review from a team as code owners May 21, 2025 20:24

jaynewstrom-stripe reviewed May 21, 2025

View reviewed changes

paymentsheet/src/main/java/com/stripe/android/paymentsheet/FlowControllerCompose.kt Outdated Show resolved Hide resolved

jaynewstrom-stripe reviewed May 21, 2025

View reviewed changes

MIGRATING.md Outdated Show resolved Hide resolved

jaynewstrom-stripe reviewed May 21, 2025

View reviewed changes

MIGRATING.md Outdated Show resolved Hide resolved

jaynewstrom-stripe reviewed May 21, 2025

View reviewed changes

MIGRATING.md Outdated Show resolved Hide resolved

cttsai-stripe marked this pull request as draft June 2, 2025 17:18

cttsai-stripe added 7 commits June 11, 2025 10:40

Update MIGRATING.md

51eedb7

Deprecate PaymentSheet constructors

4edccda

Deprecate FlowController.create()

ab74053

Deprecate rememberPaymentSheet and rememberPaymentSheetFlowController

65f43a5

Suppress deprecation

cd3cccb

Add replaceWith to deprecated Compose annotations

3c4e5ef

Update CHANGELOG.md and MIGRATING.md

ed5a5e8

cttsai-stripe force-pushed the cttsai/deprecate-payment-sheet-contructor branch from 7eb9c95 to ed5a5e8 Compare June 11, 2025 21:54

cttsai-stripe marked this pull request as ready for review June 11, 2025 21:55

Fix lint

ea07c01

cttsai-stripe requested a review from jaynewstrom-stripe June 12, 2025 17:30

jaynewstrom-stripe reviewed Jun 12, 2025

View reviewed changes

MIGRATING.md Outdated Show resolved Hide resolved

MIGRATING.md Outdated Show resolved Hide resolved

MIGRATING.md Outdated Show resolved Hide resolved

cttsai-stripe and others added 3 commits June 12, 2025 10:58

Update CHANGELOG.md

ce3a2f2

Apply suggestions from code review

73b8964

Co-authored-by: Jay Newstrom <[email protected]>

Update MIGRATING.md

0933629

cttsai-stripe requested a review from jaynewstrom-stripe June 12, 2025 20:51

jaynewstrom-stripe reviewed Jun 12, 2025

View reviewed changes

Replace Builder with PaymentSheet.Builder

4e54149

jaynewstrom-stripe approved these changes Jun 13, 2025

View reviewed changes

cttsai-stripe merged commit b36001c into master Jun 13, 2025
13 checks passed

cttsai-stripe deleted the cttsai/deprecate-payment-sheet-contructor branch June 13, 2025 17:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deprecate PaymentSheet Constructors and FlowController.create() #10833

Deprecate PaymentSheet Constructors and FlowController.create() #10833

Uh oh!

cttsai-stripe commented May 20, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 20, 2025 •

edited

Loading

Uh oh!

jaynewstrom-stripe May 21, 2025

Uh oh!

cttsai-stripe Jun 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaynewstrom-stripe Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaynewstrom-stripe Jun 12, 2025

Uh oh!

cttsai-stripe Jun 12, 2025

Uh oh!

jaynewstrom-stripe Jun 13, 2025

Uh oh!

cttsai-stripe Jun 13, 2025

Uh oh!

cttsai-stripe Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

Deprecate PaymentSheet Constructors and FlowController.create() #10833

Deprecate PaymentSheet Constructors and FlowController.create() #10833

Uh oh!

Conversation

cttsai-stripe commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Testing

Changelog

Uh oh!

github-actions bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cttsai-stripe commented May 20, 2025 •

edited

Loading

github-actions bot commented May 20, 2025 •

edited

Loading